Add various cleanup to command/prompt files#738
Conversation
📝 WalkthroughWalkthroughAdds markdown linting and a local pre-commit markdown hook: Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Dev as Developer
participant Git as Git
participant Pre as pre-commit
participant Mask as Mask (local hook)
participant MDL as markdownlint-cli
Dev->>Git: create commit
Git->>Pre: trigger pre-commit hooks
Pre->>Mask: invoke "mask development markdown all"
Mask->>MDL: run markdownlint using `.markdownlint.yaml`
MDL-->>Mask: return lint results
Mask-->>Pre: exit code (0 or non-0)
Pre-->>Git: allow or block commit
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Pull request overview
This PR adds Markdown linting infrastructure and performs cleanup/consistency improvements across command and prompt files. The changes standardize terminology (PR → pull request), fix file naming (ralph-preflight → ralph_preflight), and improve formatting for readability.
Changes:
- Added Markdown linting configuration, pre-commit hook, and Mask commands
- Standardized terminology from "PR" to "pull request" throughout maskfile
- Updated ralph-preflight.sh references to use underscore naming convention
- Improved line formatting in CLAUDE.md and README.md for better readability
Reviewed changes
Copilot reviewed 6 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| maskfile.md | Added Markdown linting commands, standardized terminology to "pull request", updated script references, changed ralph parameter from OPTIONS to positional |
| README.md | Added markdownlint disable comment and reformatted long link line |
| CLAUDE.md | Improved readability by breaking long lines and adding blank lines between sections |
| .pre-commit-config.yaml | Added Markdown linting pre-commit hook |
| .markdownlint.yaml | Created Markdown linting configuration file |
| .flox/env/manifest.toml | Added markdownlint-cli dependency |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Greptile OverviewGreptile SummaryThis PR adds Markdown linting infrastructure and improves documentation formatting consistency. The changes include:
All changes are consistent with the project's documentation standards and the Ralph workflow guidelines in Confidence Score: 5/5
|
| Filename | Overview |
|---|---|
| .markdownlint.yaml | Added markdownlint configuration with sensible defaults and promise tag support |
| .pre-commit-config.yaml | Added markdown linting hook to pre-commit checks |
| CLAUDE.md | Improved formatting, standardized terminology from PR to pull request, updated ralph command |
| maskfile.md | Added markdown linting commands, fixed formatting, standardized terminology, updated ralph command to use optional parameter |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In @.flox/env/manifest.toml:
- Line 44: Update the markdownlint-cli package path in the manifest so Nix picks
the Node package: change the value of the markdownlint-cli.pkg-path entry to
"nodePackages.markdownlint-cli" (preserve the string quotes) so the environment
activation resolves the Node package correctly.
In `@maskfile.md`:
- Around line 515-545: The markdownlint invocation in the "lint" task currently
passes "#.flox" "#.venv" "#target" as args which markdownlint-cli treats as file
globs instead of ignore patterns; update the command in the "lint" section (the
line containing markdownlint "**/*.md" "#.flox" "#.venv" "#target") to use the
proper ignore flags (e.g., --ignore or -i) for each of those paths so they are
excluded (replace each "#.flox", "#.venv", "#target" with corresponding --ignore
"<path>" entries).
Additional Comments (1)
Prompt To Fix With AIThis is a comment left during a code review.
Path: CLAUDE.md
Line: 60:60
Comment:
Documentation doesn't match the updated command signature in `maskfile.md`. The command now uses a positional parameter `[pull_request_number]` instead of `--pr <number>` flag.
```suggestion
- `mask ralph pr [pull_request_number]` - Process PR review feedback interactively
```
How can I resolve this? If you propose a fix, please make it concise. |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 9 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@CLAUDE.md`:
- Line 1: The Markdown header "# claude" uses all-lowercase; update the header
text to use conventional capitalization (e.g., change "# claude" to "# Claude"
or another title-case variant) so the document follows standard Markdown title
conventions.
- Around line 32-33: Replace the non-breaking hyphen character in the string
"third‑party" with a standard ASCII hyphen so the text reads "third-party";
locate the occurrence in CLAUDE.md (the phrase "third‑party") and update that
single character to U+002D to ensure normal search, copy-paste, and tooling
behavior.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 9 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Overview
Changes
CLAUDE.mdmaskfile.mdContext
The only functional change was I updated the pull request Mask command for Ralph to have an optional parameter. Not sure if that really breaks things.
Summary by CodeRabbit
New Features
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.